home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1993 July / Internet Tools.iso / iso9660 / mail / mh / contrib / 9210 / stack.shr < prev    next >
Encoding:
Text File  |  1992-10-22  |  29.9 KB  |  1,193 lines
  1. : Run this shell script with "sh" not "csh"
  2. PATH=:/bin:/usr/bin:/usr/ucb
  3. export PATH
  4. all=FALSE
  5. if [ $1x = -ax ]; then
  6.     all=TRUE
  7. fi
  8. /bin/echo 'Extracting stacknews'
  9. sed 's/^X//' <<'//go.sysin dd *' >stacknews
  10. #!/usr/bin/perl
  11. #
  12. # stacknews - create and maintain a folder stack for reading news
  13. #
  14. # This program builds a folder stack (separate from the MH folder stack)
  15. # of news groups to be read.  It prints the path to the appropriate
  16. # MH context file.  A separate MH context is kept for each news group.
  17. # This should speed up certain MH operations and avoids the problem of
  18. # having news group folders in your main MH context.
  19. #
  20. # Usage: 
  21. #    setenv MHCONTEXT \
  22. #        `stacknews [-(no)check] [-(no)clear] [-(no)debug] [-(no)list]
  23. #               [-(no)next] [-(no)push] [-(no)rigor] group ...`
  24. #
  25. # Options:
  26. #    -check        find the first group with new articles
  27. #    -clear        clear the folder stack
  28. #    -debug        turn on debugging
  29. #    -list        list the folder stack
  30. #    -next        pop the folder stack
  31. #    -nocheck    push all groups unconditionally
  32. #    -noclear    do not clear the folder stack
  33. #    -nodebug    operate in normal (non-debug) mode
  34. #    -nolist        do not list the folder stack
  35. #    -nonext        do not pop the folder stack
  36. #    -nopush        do not push groups onto the folder stack
  37. #    -norigor    use defaults or the environment ONLY
  38. #    -push        push groups onto the folder stack
  39. #    -rigor        check the MH profile (the usual MH stuff)
  40. #
  41. # Defaults: -check -noclear -nodebug -nonext -push -rigor
  42. #
  43. #        Any groups on the command line are pushed onto the stack.
  44. #        If no groups are specified, then all default groups are
  45. #        pushed onto the stack.
  46. #
  47. #        Mutually exclusive options: -clear, -list, -next, -push
  48. #
  49. # Some useful code to include in your .cshrc file:
  50. #
  51. #   if (! $?stacknews) then
  52. #     set stacknews = "stacknews"
  53. #   endif
  54. #   alias sninvo 'setenv MHCONTEXT `$stacknews \!*`'
  55. #   alias news 'set stacknews = "stacknews" ; sninvo'
  56. #   alias fnews 'set stacknews = "stacknews.f" ; sninvo'
  57. #   alias g 'setenv MHCONTEXT `$stacknews -next \!*`'
  58. #   alias q 'folder -fast last > /dev/null ; g'
  59. #   alias u 'setenv MHCONTEXT `$stacknews -nopush \!*`'
  60. #   alias z '$stacknews -clear \!*; unsetenv MHCONTEXT'
  61. #   alias nglist '$stacknews -list \!*'
  62. #
  63. # The code above defines the following commands:
  64. #    g    -- Go to the next news group.
  65. #    news    -- Read new news groups.
  66. #    nglist    -- See the current state of the news stack.
  67. #    q    -- Set the last article to be the current article
  68. #        --     and go to the next news group.
  69. #    sninvo    -- Utility alias to invoke stacknews.
  70. #    u    -- Set ("update") another shell's MHCONTEXT ...
  71. #            but unfortunately doesn't handle the case
  72. #            of an alternative set of news groups, e.g.
  73. #            as read by stacknews.f
  74. #    z    -- Stop reading news altogether.
  75. #
  76. #
  77. # Environment variables:
  78. #    HOME        path of home directory
  79. #    MH        path of MH profile file
  80. #    MHCONTEXT    path of current MH context file
  81. #    NEWSARTS     path of top directory containing news articles
  82. #    NEWSCONTEXTS    path of directory containing folder contexts
  83. #    NEWSGROUPS    list of colon-separated news groups to read
  84. #
  85. # MH profile components:
  86. #    context        path of MH context file
  87. #    path        path of MH directory
  88. #    (prog)        default options
  89. #    (prog)-arts    path of top directory containing news articles
  90. #    (prog)-contexts    path of directory containing folder contexts
  91. #    (prog)-defaults    path of file containing list of news groups
  92. #    (prog)-groups    list of comma-separated news groups to read
  93. #
  94. # Note: "(prog)" above is the invocation name of the program;
  95. #    MH profile components might be named stacknews-defaults, 
  96. #    stacknews-groups, and stacknews-arts, if the program is invoked
  97. #    as "stacknews".
  98. #
  99. # Files and Directories:
  100. #    $HOME/.mh_profile        default MH profile
  101. #    $HOME/.news-contexts        default news folder contexts directory
  102. #    $HOME/.news-contexts/Stack    news folder stack
  103. #    $HOME/.news-defaults        list of default news groups
  104. #    $HOME/Mail            default MH directory
  105. #    $HOME/Mail/context        default MH context file
  106. #
  107. # Author: Jerry Sweet <jns@fernwood.mpk.ca.us>
  108. # Taken from my old, similar, but much slower, "news" program.
  109. #
  110. # $Header: /q2/uh/jsweet/src/mh-front/RCS/stacknews,v 1.6 1992/06/11 18:24:52 jsweet Exp $
  111.  
  112. #
  113. # Subprograms
  114. #
  115.  
  116. sub relative_to_absolute {
  117.   local($_) = @_;
  118.  
  119.   if ($_ !~ /^\//) {
  120.     $_ = sprintf("%s%s%s", $mhroot, $_ ? '/' : '', $_);
  121.   }
  122.   if ($_ !~ /^\//) {
  123.     $_ = sprintf("%s/%s", $ENV{'HOME'}, $_);
  124.   }
  125.   $_;
  126. }
  127.  
  128. sub destroy_cur {
  129.   local($dir) = @_;
  130.   local($sequence_file) = "$dir/.mh_sequences";
  131.  
  132.   unlink $sequence_file if ($update_cur && -e $sequence_file);
  133.       # This is the only known way (in MH 6.6 at least) to reset cur if new
  134.       # messages have arrived in a folder (via rcvstore) after all messages
  135.       # were removed or refiled.
  136. }
  137.  
  138. #
  139. # Main
  140. #
  141.  
  142. umask 077;    # This should be adjustable, but isn't at the moment.
  143.  
  144. ($prog = $0) =~ s%.*/%%;
  145.  
  146. $newsarts = defined $ENV{'NEWSARTS'} ? $ENV{'NEWSARTS'} : '/usr/spool/news';
  147. $HOME = $ENV{'HOME'} ;
  148. $profile = defined $ENV{'MH'} ? $ENV{'MH'} : "$HOME/.mh_profile";
  149. $mhroot = "$HOME/Mail";
  150. if (defined $ENV{'NEWSGROUPS'}) {
  151.   @groups = split(/:/, $ENV{'NEWSGROUPS'});
  152. }
  153. $contexts = defined $ENV{'NEWSCONTEXTS'} ? 
  154.             $ENV{'NEWSCONTEXTS'} : 
  155.             "$HOME/.news-contexts";
  156. $mhcontext = defined $ENV{'MHCONTEXT'} ?
  157.             $ENV{'MHCONTEXT'} :
  158.             "$mhroot/context";
  159.  
  160. $check_folders = 1;
  161. $rigor = 1;
  162. $push = 1;
  163.  
  164. # Look for the -norigor option in the command line.
  165.  
  166. while ($_ = shift @ARGV) {
  167.   push(@Args, $_);
  168.   /^-norigor$/ && $rigor--;
  169.   /^-rigor$/   && $rigor++;
  170. }
  171.  
  172. if ($rigor > 0) {
  173.   $ndfile = -e "$HOME/.news-defaults" ? "$HOME/.news-defaults" : '';
  174.  
  175.   $profile_component = 'x-bogus';
  176.   
  177.   if (! open(PROFILE, "<$profile")) {
  178.     print STDERR "$prog: can't open profile \"$profile\" - $!\n";
  179.   }
  180.   else {
  181.     while (<PROFILE>) {
  182.       /^(\S+):\s*/ && do {
  183.           ($profile_component = $1) =~ tr/A-Z/a-z/;
  184.           $PROFILE_COMPONENT{$profile_component} = $';
  185.       };
  186.   
  187.       /^[ \t]/ && do {
  188.           $PROFILE_COMPONENT{$profile_component} .= $_;
  189.       };
  190.     }
  191.   
  192.     if (defined $PROFILE_COMPONENT{'path'}) {
  193.       $_ = $PROFILE_COMPONENT{'path'};
  194.       /^\s*(\S+)/ && do { $mhroot = $1; };
  195.     }
  196.     if (defined $PROFILE_COMPONENT{'context'}) {
  197.       $_ = $PROFILE_COMPONENT{'context'};
  198.       /^\s*(\S+)/ && do { 
  199.           $mhcontext = $1; 
  200.           if ($mhcontext !~ /^\//) {
  201.               $mhcontext = "$mhroot/$mhcontext";
  202.           }
  203.       };
  204.     }
  205.     if (defined $PROFILE_COMPONENT{$prog}) {
  206.       $_ = $PROFILE_COMPONENT{$prog};
  207.       @Args = (split, @Args);
  208.     }
  209.     if (defined $PROFILE_COMPONENT{"$prog-arts"}) {
  210.       $_ = $PROFILE_COMPONENT{"$prog-arts"};
  211.       /^\s*(\S+)/ && do { $newsarts = $1; };
  212.     }
  213.     if (defined $PROFILE_COMPONENT{"$prog-contexts"}) {
  214.       $_ = $PROFILE_COMPONENT{"$prog-contexts"};
  215.       /^\s*(\S+)/ && do { 
  216.           $contexts = $1; 
  217.           if ($contexts !~ /^\//) {
  218.               $contexts = "$mhroot/$contexts";
  219.           }
  220.       };
  221.     }
  222.     if (defined $PROFILE_COMPONENT{"$prog-defaults"}) {
  223.       $_ = $PROFILE_COMPONENT{"$prog-defaults"};
  224.       /^\s*(\S+)/ && do { 
  225.           $ndfile = $1; 
  226.           if ($contexts !~ /^\//) {
  227.               $contexts = "$mhroot/$contexts";
  228.           }
  229.       };
  230.     }
  231.     if (defined $PROFILE_COMPONENT{"$prog-groups"}) {
  232.       $_ = $PROFILE_COMPONENT{"$prog-groups"};
  233.       @profile_groups = split(/\s*,\s*/);
  234.     }
  235.   }
  236. }
  237.  
  238. # Evaluate the switches:
  239.  
  240. while ($_ = shift @Args) {
  241.   /^-check$/      && $check_folders++;
  242.   /^-clear$/      && $clear_stack++;
  243.   /^-debug$/      && $debug++;
  244.   /^-list$/      && $list++;
  245.   /^-next$/      && $next++;
  246.   /^-nocheck$/      && $check_folders--;
  247.   /^-noclear$/      && $clear_stack--;
  248.   /^-nodebug$/      && $debug--;
  249.   /^-nolist$/      && $list--;
  250.   /^-nonext$/      && $next--;
  251.   /^-nopush$/     && $push--;
  252.   /^-push$/       && $push++;
  253.   /^[^-]/      && push(@switch_groups, $_);
  254. }
  255.  
  256. if (! -d $contexts) {
  257.   if (! mkdir($contexts, 0700)) {
  258.     print STDERR "$prog: can't mkdir \"$contexts\" - $!\n";
  259.     exit 1;
  260.   }
  261. }
  262.  
  263.   
  264. $folder_stack = "$contexts/Stack";
  265.  
  266. if ($clear_stack > 0) {
  267.   @groups = ();
  268. }
  269. else {
  270.   # Read the folder stack:
  271.   
  272.   if (-e $folder_stack) {
  273.     if (! open(STACK, "<$folder_stack")) {
  274.       print STDERR 
  275.       "$prog: can't open folder stack file \"$folder_stack\" - $!\n";
  276.       print "$mhcontext\n" unless ! $print_context;
  277.       exit 1;
  278.     }
  279.     foreach (<STACK>) {
  280.       next if /^#|^\s*$/;
  281.       push(@stack, split);
  282.     }
  283.   }
  284.  
  285.   if ($list > 0) {
  286.     foreach (@stack) {
  287.       push(@group_list, $_);
  288.     }
  289.  
  290.     if ($#group_list >= 0) {
  291.       print STDERR join(' ', @group_list), "\n";
  292.     }
  293.     exit 0;
  294.   }
  295. }
  296.  
  297. shift(@stack) if ($next > 0);  # If we saw -next, then pop the stack.
  298.  
  299. if ($clear_stack <= 0 && $next <= 0 && $push > 0) {
  300.   # Decide on the news groups at which to look:
  301.  
  302.   if ($#switch_groups < 0 && $#profile_groups >= 0) {
  303.     push(@groups, @profile_groups);
  304.         # Select groups from the (prog)-groups: component.
  305.   }
  306.  
  307.   if ($#groups < 0 && $#switch_groups < 0 && $ndfile) {
  308.     # Look at the .news-defaults file:
  309.   
  310.     if (! open(NDFILE, $ndfile)) {
  311.       print STDERR "$prog: can't open news defaults file \"$ndfile\" - $!\n";
  312.       print "$mhcontext\n" unless ! $print_context;
  313.       exit 1;
  314.     }
  315.   
  316.     while (<NDFILE>) {
  317.       next if /^#|^\s*$/;
  318.       split;
  319.       push(@groups, @_);
  320.     }
  321.   }
  322.  
  323.   # Push news groups onto the folder stack:
  324.   
  325.   push(@stack, @groups);
  326.  
  327.   # Push groups from the command line onto the front of the stack:
  328.  
  329.   foreach (reverse(@switch_groups)) {
  330.     unshift(@stack, $_);
  331.   }
  332. }
  333.  
  334. if ($clear_stack <= 0 && $push > 0) {
  335.   # Find the first group for which new articles have arrived:
  336.  
  337.   if ($check_folders > 0) {
  338.     select(STDERR);
  339.     $| = 1;    # Force output of '.' as we look for a good group
  340.     select(STDOUT);
  341.   }
  342.  
  343.   $newsarts_cur = $newsarts;
  344.  
  345.   while ($#stack >= 0) {
  346.     ($_ = $stack[0]) =~ s/\s+//g;
  347.  
  348.     # An item beginning with '+' specifies a folder instead of
  349.     # a news group.
  350.  
  351.     if (/^\+/) {
  352.       $_ = $';
  353.       $group = $_;
  354.       $dir = &relative_to_absolute($_);
  355.       $folder = $_;
  356.       s%/%.%g;
  357.       $cur_context = "$contexts/FOLDER.$_";
  358.           # Bug: +foo.bar will have the same context as +foo/bar.
  359.       $update_cur = 1;
  360.     }
  361.     else  {
  362.       $group = $_;
  363.       s%\.%/%g;
  364.       $dir = "$newsarts_cur/$_";
  365.       $folder = $dir;
  366.       $cur_context = "$contexts/$group";
  367.       $update_cur = 0;
  368.     }
  369.  
  370.     # print STDERR "group  = \"$group\"\n", 
  371.     #          "dir    = \"$dir\"\n",
  372.     #          "folder = \"$folder\"\n",
  373.     #          "ctxt   = \"$cur_context\"\n",
  374.     #          "stack  = ", join(' ', @stack), "\n"
  375.     #     ;
  376.  
  377.     last if ($check_folders <= 0);
  378.  
  379.     if (! -d $dir) {
  380.       print STDERR "\nno such news group as $group\n";
  381.       shift @stack;
  382.       next;
  383.     }
  384.   
  385.     $ENV{'MHCONTEXT'} = $cur_context;
  386.     $finfo = `folder +$folder`;
  387.     if ($? >> 8) {
  388.       print STDERR "\nfolder change to +$folder failed\n";
  389.       shift @stack;
  390.       next;
  391.     }
  392.     print(STDERR $finfo) if ($debug > 0);
  393.   
  394.     if ($finfo =~ /\s+has\s+no\s+/) {
  395.       # There are no messages in this folder, so ensure that the cur
  396.       # sequence is destroyed and go on to the next folder.
  397.  
  398.       &destroy_cur($dir);
  399.       print STDERR '.';
  400.       $dots++;
  401.       shift @stack;
  402.       next;
  403.     }
  404.   
  405.     if ($finfo =~ /cur=\s*(\d+)/) {
  406.       $cur = $1;
  407.     }
  408.     else {
  409.       # There are messages in here, but there's no cur message apparent,
  410.       # so reset the cur sequence.
  411.  
  412.       &destroy_cur($dir);
  413.       $cur = 0;
  414.     }
  415.   
  416.     if ($finfo =~ /message.*\(\s*(\d+)-\s*(\d+)\s*\)/) {
  417.       $lastm = $2;
  418.   
  419.       if ($cur >= $lastm) {
  420.         # We don't have any new messages in this folder, so go on to
  421.         # the next one.  (Bug: we should check for an "unseen" sequence.)
  422.  
  423.         print STDERR '.';
  424.         $dots++;
  425.         shift @stack;
  426.         next;
  427.       }
  428.       else {
  429.         last;  # Found a live one.
  430.       }
  431.     }
  432.   }  # end while
  433.   
  434.   if ($dots > 0) {
  435.     print STDERR "\n";
  436.     select(STDERR);
  437.     $| = 0;
  438.     select(STDOUT);
  439.   }
  440. }  
  441.  
  442. # Rewrite the folder stack file:
  443.  
  444. if ($clear_stack > 0) {
  445.   @stack = ();
  446. }
  447.  
  448. if ($push > 0) {
  449.   if (! open(STACK, ">$folder_stack")) {
  450.     print STDERR 
  451.       "$prog: can't rewrite folder stack file \"$folder_stack\" - $!\n";
  452.     print "$mhcontext\n" unless ! $print_context;
  453.     exit 1;
  454.   }
  455.   if ( (! print STACK join(' ', @stack)) || ! close(STACK) ) {
  456.     print STDERR 
  457.       "$prog: can't write folder stack file \"$folder_stack\" - $!\n";
  458.     print "$mhcontext\n" unless ! $print_context;
  459.     exit 1;
  460.   }
  461. }
  462.  
  463. if ($clear_stack > 0) {
  464.   exit 0;
  465. }
  466.  
  467. # Tell the user what the state of the folder stack is:
  468.  
  469. if ($#stack >= 0) {
  470.   $_ = $stack[0];
  471.  
  472.   if ($next <= 0) {
  473.     printf(STDERR "%d news group%s selected; topmost: %s\n", 
  474.           $#stack + 1,
  475.           $#stack > 0 ? 's' : '',
  476.           $_);
  477.   }
  478.   else {
  479.     print STDERR "topmost: $_\n";
  480.   }
  481.  
  482.   if (/^\+/) {
  483.     $_ = $';
  484.     s%/%.%g;
  485.     print "$contexts/FOLDER.$_\n";
  486.   }
  487.   else {
  488.     print "$contexts/$_\n";
  489.   }
  490. }
  491. else {
  492.   if ($next <= 0) {
  493.     print STDERR "no news groups selected\n";
  494.   }
  495.   print "$mhcontext\n" unless ! $print_context;
  496. }
  497.  
  498. exit 0;
  499. //go.sysin dd *
  500. made=TRUE
  501. if [ $made = TRUE ]; then
  502.     /bin/chmod 555 stacknews
  503.     /bin/echo -n '    '; /bin/ls -ld stacknews
  504. fi
  505. /bin/echo 'Extracting stacknews.aliases'
  506. sed 's/^X//' <<'//go.sysin dd *' >stacknews.aliases
  507. # stacknews.aliases - Stacknews-related csh aliases
  508. #
  509. # Usage: source <path>/stacknews.aliases
  510. #
  511. # Author: Jerry Sweet <jsweet@ics.uci.edu>
  512. #
  513. # $Id: stacknews.aliases,v 1.1 1992/08/20 19:27:23 jsweet Exp $
  514.  
  515. if (! $?stacknews) then
  516.   set stacknews = "stacknews"
  517. endif
  518. alias sninvo 'setenv MHCONTEXT `$stacknews \!*`'
  519. alias news 'set stacknews = "stacknews" ; sninvo'
  520. alias fnews 'set stacknews = "stacknews.f" ; sninvo'
  521. alias g 'setenv MHCONTEXT `$stacknews -next \!*`'
  522. alias q 'folder -fast last >& /dev/null ; g'
  523. alias u 'setenv MHCONTEXT `$stacknews -nopush \!*`'
  524. alias z '$stacknews -clear \!*; unsetenv MHCONTEXT'
  525. alias nglist '$stacknews -list \!*'
  526. //go.sysin dd *
  527. made=TRUE
  528. if [ $made = TRUE ]; then
  529.     /bin/chmod 400 stacknews.aliases
  530.     /bin/echo -n '    '; /bin/ls -ld stacknews.aliases
  531. fi
  532. /bin/echo 'Extracting stacknews.l'
  533. sed 's/^X//' <<'//go.sysin dd *' >stacknews.l
  534. X.\"    $Header: /q2/uh/jsweet/src/mh-front/RCS/stacknews.l,v 1.3 1992/06/11 18:41:48 jsweet Exp $
  535. X.\"
  536. X.TH STACKNEWS 1 STACKNEWS
  537. X.UC 6
  538. X.SH NAME
  539. stacknews \- USENET news + MH utility
  540.  
  541. X.SH SYNOPSIS
  542. setenv MHCONTEXT `stacknews 
  543. \%[\-(no)check]
  544. \%[\-(no)clear]
  545. \%[\-(no)debug]
  546. \%[\-(no)list]
  547. \%[\-(no)next]
  548. \%[\-(no)push]
  549. \%[\-(no)rigor]
  550. \%[newsgroup ...]
  551. \%[+folder ...]`
  552.  
  553. X.SH DESCRIPTION
  554.  
  555. Stacknews is a utility program for reading USENET news via MH.
  556. Stacknews works in conjunction with the c-shell and MH to permit you
  557. to read news at the shell level, without resorting to news readers such
  558. as nn or rn.
  559.  
  560. Stacknews is not itself the command that you invoke to read news;
  561. other commands do that on your behalf, such as "news", "g", "z", and
  562. "nglist".
  563. These commands are c-shell aliases that invoke stacknews with
  564. the appropriate options to perform different operations.
  565.  
  566. To use stacknews, you must add some alias definitions to your .cshrc
  567. file.  The required code is described in the INSTALLATION section of
  568. this man page.
  569.  
  570. More complete descriptions of the various stacknews-related news
  571. reading commands are:
  572. X.in +1i
  573.  
  574. X.ti -.5i
  575. news
  576. X.br
  577. Creates the initial conditions necessary to begin reading news at the
  578. shell level: the list of news group folders is built, and the first 
  579. folder is selected.
  580.  
  581. X.ti -.5i
  582. g
  583. X.br
  584. Goes to the next news group in the list.
  585.  
  586. X.ti -.5i
  587. q
  588. X.br
  589. Quits a news group and goes to the next one.
  590. This is similar to the "g" command, but before going to the next news group,
  591. the "q" command sets the last message to be current.
  592.  
  593. X.ti -.5i
  594. u
  595. X.br
  596. Updates the current shell so that news reading can pick up where it
  597. left off.
  598. This is useful if you logged out before reading all your news,
  599. or if you switched windows.
  600.  
  601. X.ti -.5i
  602. z
  603. X.br
  604. Clears the list of news groups and permits you to stop reading news
  605. altogether.
  606.  
  607. X.ti -.5i
  608. nglist
  609. X.br
  610. Lists the news groups waiting to be read.
  611.  
  612. X.in -1i
  613.  
  614. Stacknews allows folders to be used interchangeably with news groups.
  615. This facility is of particular use with automatically updated folders,
  616. e.g. those folders to which incoming e-mail is automatically redirected
  617. via the rcvstore(1) program.
  618.  
  619.  
  620. X.SH INSTALLATION
  621.  
  622. Stacknews requires certain semi-specialized conditions to pertain:
  623. X.PP
  624. X.in +.5i
  625. 1) Stacknews can be used only on the primary news machine, unless the news
  626. spool directory (typically /usr/spool/news) is NFS-mounted.
  627. Stacknews does not require that the news spool directory be present
  628. if you read NO news groups, and specify only your own folders.
  629. X.PP
  630. X.in +.5i
  631. 2) Stacknews is written in perl, and therefore perl 4.0 or later must be
  632. installed on your system.
  633. X.PP
  634. X.in +.5i
  635. 3) Stacknews uses certain specialized features of MH, and therefore 
  636. MH 6.6 or later must be installed on your system.
  637. X.in -.5i
  638. X.PP
  639.  
  640. If you aren't sure whether these conditions pertain,
  641. take these steps to find out:
  642. X.PP
  643. 1. Type this command:
  644. X.in +.5i
  645. ls /usr/spool/news
  646. X.in -.5i
  647. X.PP
  648. If you don't see anything in that directory, or if it doesn't exist,
  649. then you can't use stacknews to read USENET news.
  650. If the news spool directory is something other than /usr/spool/news,
  651. then you may specify the alternative news spool directory in
  652. the stacknews-arts component in your .mh_profile (see the MH PROFILE
  653. COMPONENTS section in this document).
  654. If you don't have a news spool directory on your machine,
  655. you can still use stacknews to read folders.
  656. X.PP
  657. 2. Type this command:
  658. X.in +.5i
  659. perl -v
  660. X.in -.5i
  661. X.PP
  662. If the version number displayed isn't 4.0 or later, then you might
  663. have problems running stacknews.
  664. You can give it a try, but it isn't guaranteed to work.
  665. X.PP
  666. 3. Type this command:
  667. X.in +.5i
  668. folder -help
  669. X.in -.5i
  670. X.PP
  671. If the version number of MH displayed at the bottom of the output of
  672. the "folder" command isn't 6.6 or greater, 
  673. then the version of MH on your system may lack the features necessary
  674. to support stacknews.
  675. You can give it a try, but it isn't guaranteed to work.
  676.  
  677. The stacknews program itself may be installed anywhere.  
  678. The directory /usr/local/bin is not a bad choice.
  679. If you don't have access to that directory, then choose some
  680. directory that occurs in your PATH, e.g. ~/bin.
  681.  
  682. Add these lines to the .cshrc file in your home directory:
  683. X.in +.5i
  684. # Define some stacknews-related aliases
  685. X.br
  686.  
  687. X.br
  688. if\ (!\ $?stacknews)\ then
  689. X.br
  690. \ \ set\ stacknews\ =\ "stacknews"
  691. X.br
  692. endif
  693. X.br
  694. alias\ sninvo\ 'setenv\ MHCONTEXT\ `$stacknews\ \!*`'
  695. X.br
  696. alias\ news\ 'set\ stacknews\ =\ "stacknews"\ ;\ sninvo'
  697. X.br
  698. alias\ g\ 'setenv\ MHCONTEXT\ `$stacknews\ \-next\ \!*`'
  699. X.br
  700. alias\ q\ 'folder\ \-fast\ last\ >\ /dev/null\ ;\ g'
  701. X.br
  702. alias\ u\ 'setenv\ MHCONTEXT\ `$stacknews\ \-nopush\ \!*`'
  703. X.br
  704. alias\ z\ '$stacknews\ \-clear\ \!*;\ unsetenv\ MHCONTEXT'
  705. X.br
  706. alias\ nglist\ '$stacknews\ \-list\ \!*'
  707. X.in -.5i
  708.  
  709. If you don't already have a .cshrc file in your home directory, then
  710. you must create a .cshrc file to contain the alias definitions above.
  711.  
  712. If any of the stacknews aliases described above conflict with
  713. existing aliases, 
  714. then you'll have to select new names either for the stacknews aliases or for
  715. the previously existing aliases.
  716.  
  717. After you've modified your .cshrc file, at the c-shell prompt
  718. type these commands:
  719. X.PP
  720. X.in +.5i
  721. source\ ~/.cshrc
  722. X.br
  723. rehash
  724. X.in -.5i
  725. X.PP
  726.  
  727. Place into the .news\-defaults file in your home directory the following
  728. lines:
  729. X.PP
  730. X.in +.5i
  731. news.announce.newusers
  732. X.br
  733. news.announce.important
  734. X.br
  735. news.answers
  736. X.br
  737. comp.lang.perl
  738. X.br
  739. comp.mail.mh
  740. X.in -.5i
  741. X.PP
  742. Feel free to add or to delete news groups as needed.  
  743.  
  744. If you have arranged for some of your folders to be updated automatically
  745. via rcvstore(1), you may place folder specifications as well as news groups
  746. into the .news\-defaults file, e.g.:
  747. X.in +.5i
  748. +lists/mh-mime
  749. X.br
  750. +lists/com-priv
  751. X.in -.5i
  752. X.PP
  753.  
  754. To find out what news groups are available, type this command:
  755. X.in +.5i
  756. more ~news/newsgroups
  757. X.in -.5i
  758. X.PP
  759. Other commands may be necessary to find out what news groups are
  760. available on your system.
  761.  
  762.  
  763. X.SH TUTORIAL
  764.  
  765. When you have performed the necessary setups described in the previous 
  766. section, type this command:
  767. X.in +.5i
  768. news
  769. X.in -.5i
  770. X.PP
  771.  
  772. You should see something like this:
  773. X.in +.5i
  774. 5 news groups selected; topmost: news.announce.newusers
  775. X.br
  776. % 
  777. X.in -.5i
  778. X.PP
  779.  
  780. Your current folder becomes the news group "news.announce.newusers",
  781. which is the first news group listed in your ~/.news\-defaults file.
  782.  
  783. To read the next new message, type
  784. X.in +.5i
  785. next
  786. X.in -.5i
  787. X.PP
  788. To scan the available messages, type 
  789. X.in +.5i
  790. scan next-last
  791. X.in -.5i
  792. X.PP
  793.  
  794. To move on to the next news group, type 
  795. X.in +.5i
  796. g
  797. X.in -.5i
  798. X.PP
  799. If you see dots (".") printed, that means that stacknews is discarding
  800. news groups in which no new articles have appeared.
  801.  
  802. To select a completely different news group to read next, e.g. "alt.sex",
  803. type
  804. X.in +.5i
  805. news alt.sex
  806. X.in -.5i
  807. X.PP
  808. (The aforementioned news group is not available everywhere, so substitute
  809. some available news group.)
  810.  
  811. To return to a news group in which you might have read the last
  812. message already, e.g. "news.announce.newusers", type
  813. X.in +.5i
  814. news -nocheck news.newusers
  815. X.in -.5i
  816. X.PP
  817.  
  818. To see the list of news groups to be read, type 
  819. X.in +.5i
  820. nglist
  821. X.in -.5i
  822. X.PP
  823.  
  824. If you change windows, or log out and log back in again later, and
  825. you wish to resume reading news, then type 
  826. X.in +.5i
  827. u
  828. X.in -.5i
  829. X.PP
  830.  
  831. To stop reading news, type 
  832. X.in +.5i
  833. z
  834. X.in -.5i
  835. X.PP
  836.  
  837.  
  838. X.SH OPTIONS
  839.  
  840. Stacknews is designed to be invoked via c-shell aliases.  Therefore,
  841. you should not find it desirable or necessary to invoke stacknews
  842. directly.  Furthermore, the various options to stacknews are not
  843. guaranteed to interoperate, except as they are used in the c-shell
  844. aliases listed in the INSTALLATION section.
  845.  
  846. The default settings are:
  847. X.in +.5i
  848. \-check \-noclear \-nodebug \-nonext \-push \-rigor
  849. X.in +.5i
  850. X.PP
  851.  
  852. Any news groups specified on the command line are pushed onto the 
  853. news group stack.
  854. If no groups are specified, then all default groups are
  855. pushed onto the stack (typically from ~/.news-defaults).
  856.  
  857. Mutually exclusive options: \-clear, \-list, \-next, \-push.
  858.  
  859.  
  860. The options are:
  861.  
  862. X.in +1i
  863.  
  864. X.ti -.5i
  865. -check
  866. X.ti -.5i
  867. -nocheck
  868. X.br
  869. By default, when stacknews selects a new news group, 
  870. it is simply discarded if it has no new articles.
  871. A group is considered to have new articles if there are articles following
  872. the "cur" message sequence.
  873. The -nocheck option prevents the check for new articles; a group is
  874. pushed unconditionally.
  875. The -check option corresponds to the default behavior; it negates
  876. a -nocheck option if -nocheck is present.
  877.  
  878. X.ti -.5i
  879. -clear
  880. X.ti -.5i
  881. -noclear
  882. X.br
  883. The -clear option causes stacknews to clear the news group stack.
  884. The -noclear option simply negates the -clear option when the -clear
  885. option is present.
  886.  
  887. X.ti -.5i
  888. -debug
  889. X.ti -.5i
  890. -nodebug
  891. X.br
  892. The -debug option causes a limited amount of information to be printed
  893. on STDERR that is not normally displayed.
  894.  
  895. X.ti -.5i
  896. -list
  897. X.ti -.5i
  898. -nolist
  899. X.br
  900. The -list option causes the state of the news group stack to be printed.
  901. The -nolist option negates the -list option when the -list option is
  902. present.
  903.  
  904. X.ti -.5i
  905. -next
  906. X.ti -.5i
  907. -nonext
  908. X.br
  909. The -next option pops the news group stack and causes the next news
  910. group that contains new articles to be selected.
  911. If the -nocheck option is present, the check for new articles is suppressed,
  912. and the next news group in the news group stack is selected unconditionally.
  913. The -nonext option negates the -next option when the -next option is
  914. present.
  915.  
  916. X.ti -.5i
  917. -push
  918. X.ti -.5i
  919. -nopush
  920. X.br
  921. The -push option pushes a new news group onto the top of the news group
  922. stack.
  923. The -nopush option in a sense performs no operation,
  924. except that it causes the topmost news group to be selected.
  925.  
  926. X.ti -.5i
  927. -rigor
  928. X.ti -.5i
  929. -norigor
  930. X.br
  931. By default, stacknews functions as a normal MH program does, i.e. it
  932. checks the environment for relevant information and then checks
  933. the user's MH profile file (typically .mh_profile in the home directory).
  934. The -norigor option causes the MH profile to be ignored; only the
  935. environment is considered.
  936.  
  937.  
  938. X.in -1i
  939.  
  940. X.SH DESIGN RATIONALE
  941.  
  942. Most USENET news implementations organize news groups as directories.
  943. To translate a USENET news group into a directory path, substitute
  944. slashes ("/") for dots ("."), and prepend the path of the news spool
  945. directory, typically /usr/spool/news.
  946.  
  947. MH already uses directories relative to a pre-determined path for folders, 
  948. e.g. the notation "+inbox" refers to the directory "$HOME/Mail/inbox".
  949. Fortunately, MH can also use an absolute path in a folder specification.
  950. A USENET news group is treated by stacknews as a folder with an
  951. absolute path, e.g. "+/usr/spool/news/comp/lang/perl".
  952.  
  953. For most users, a USENET news group will be treated as a read-only folder.
  954. Because of the way MH interacts with read-only folders,
  955. certain MH features, such as message annotation (anno), digest
  956. bursting (burst), and refiling (refile) should not be expected to
  957. work properly when read-only folders are selected,
  958. although some work-arounds are possible.
  959. The majority of MH features are available, 
  960. such as pick(1), forw(1), show(1), etc.
  961.  
  962. Because MH slows down considerably when a large number of private
  963. sequences accumulates in the default context file, 
  964. a separate context is kept for each news group.
  965. The prevailing context is specified by setting the environment
  966. variable MHCONTEXT, which is recognized by all MH programs.
  967.  
  968. C-shell aliases are employed to implement the various stacknews-related 
  969. commands.
  970. Using c-shell aliases permits the output of stacknews to be used to set
  971. the MHCONTEXT variable.
  972.  
  973. UNIX presently does not permit environment information to be shared among
  974. different "peer" processes.
  975. To overcome this problem, the "u" command is provided to
  976. "update" the MHCONTEXT variable among different interactive shells,
  977. e.g. login sessions and windows.
  978.  
  979. By invoking the "news" command, you build a stack of news groups or
  980. folders that you want to read in sequence.
  981. A default list of news groups to be read is taken from a file that you 
  982. create, ~/.news-defaults.
  983. Progression from news group to news group is accomplished by invoking
  984. "g", which is a command to "pop" succeeding folders off the top of the list.
  985.  
  986. Because the default MH folder stack, as used by "folder\ \-push",
  987. is kept in the context file,
  988. and because the context changes according to the setting of the
  989. MHCONTEXT variable,
  990. stacknews maintains an entirely separate folder stack.
  991.  
  992.  
  993. X.SH ENVIRONMENT
  994.  
  995. Stacknews uses many different environment variables, some in common
  996. with MH.
  997. They are:
  998. X.in +1i
  999. X.ti -.5i
  1000. HOME
  1001. X.br
  1002. Path of home directory.  
  1003.  
  1004. X.ti -.5i
  1005. MH
  1006. X.br
  1007. Path of MH profile file.  Used by all MH programs.
  1008. Default: ~/.mh_profile.
  1009.  
  1010. X.ti -.5i
  1011. MHCONTEXT
  1012. X.br
  1013. Path of current MH context file.  Used by all MH programs.
  1014. Default: ~/Mail/context.
  1015.  
  1016. X.ti -.5i
  1017. NEWSARTS
  1018. X.br
  1019. Path of top directory containing news articles.
  1020. Default: /usr/spool/news.
  1021.  
  1022. X.ti -.5i
  1023. NEWSCONTEXTS
  1024. X.br
  1025. Path of directory containing folder contexts
  1026. Default: ~/.news-contexts.
  1027.  
  1028. X.ti -.5i
  1029. NEWSGROUPS
  1030. X.br
  1031. List of colon-separated news groups to read.
  1032. Defaults: as specified in ~/.news-defaults.
  1033.  
  1034. X.in -1i
  1035.  
  1036. X.SH MH PROFILE COMPONENTS
  1037.  
  1038. Stacknews reads the MH profile unless the -norigor option is specified.
  1039.  
  1040. The MH environment variable is consulted to determine which MH profile
  1041. file to read.
  1042. If the MH environment variable is not defined, then the ~/.mh_profile
  1043. file is read.
  1044.  
  1045. The MH profile components relevant to stacknews are:
  1046.  
  1047. X.in +1i
  1048.  
  1049. X.ti -.5i
  1050. context:
  1051. X.br
  1052. Path of MH context file.
  1053. Default: as specified in the MHCONTEXT environment variable, or 
  1054. ~/Mail/context.
  1055.  
  1056. X.ti -.5i
  1057. Path:
  1058. X.br
  1059. Path of MH directory.
  1060. Default: ~/Mail.
  1061.  
  1062. X.ti -.5i
  1063. stacknews:
  1064. X.br
  1065. Stacknews options.
  1066. Defaults: \-check \-noclear \-nodebug \-nonext \-push \-rigor.
  1067.  
  1068. X.ti -.5i
  1069. stacknews-arts:
  1070. X.br
  1071. Path of top directory containing news articles.
  1072. Default: As specified by the NEWSARTS environment variable or
  1073. X/usr/spool/news.
  1074.  
  1075. X.ti -.5i
  1076. stacknews-contexts:
  1077. X.br
  1078. Path of directory containing folder contexts.
  1079. Default: As specified by the NEWSCONTEXTS environment variable or
  1080. ~/.news-contexts.
  1081.  
  1082. X.ti -.5i
  1083. stacknews-defaults:
  1084. X.br
  1085. Path of file containing list of news groups.
  1086. Default: ~/.news-defaults.
  1087.  
  1088. X.ti -.5i
  1089. stacknews-groups:
  1090. X.br
  1091. List of comma-separated news groups to read.
  1092. Defaults: as specified in the NEWSGROUPS environment variable,
  1093. or as specified in ~/.news-defaults.
  1094.  
  1095. X.in -1i
  1096.  
  1097. Where "stacknews" is specified in a .mh_profile component,
  1098. stacknews looks for its invocation name.
  1099. The relevant MH profile components are therefore normally
  1100. named stacknews-defaults, stacknews-groups, and stacknews-arts.
  1101. However, if stacknews were invoked as "stn", then stacknews would
  1102. instead look for components named stn-defaults, stn-groups,
  1103. and stn-arts.
  1104. The variable prefix for components permits different invocations
  1105. of stacknews to use different sets of options.
  1106.  
  1107.  
  1108. X.SH FILES
  1109.  
  1110. X.in +1i
  1111.  
  1112. X.ti -.5i
  1113. $HOME/.mh_profile
  1114. X.br
  1115. Default MH profile.
  1116.  
  1117. X.ti -.5i
  1118. $HOME/.news-contexts
  1119. X.br
  1120. Default news folder contexts directory.
  1121. All of the context files to which MHCONTEXT refers are kept here.
  1122.  
  1123. X.ti -.5i
  1124. $HOME/.news-contexts/Stack
  1125. X.br
  1126. News folder stack.
  1127.  
  1128. X.ti -.5i
  1129. $HOME/.news-contexts/FOLDER.*
  1130. X.br
  1131. Context files for folders.
  1132. For example, "FOLDER.lists.mh-mime" is the context file for the 
  1133. folder "+lists/mh-mime".
  1134. (This representation has a problem in that dots in folder names
  1135. may result in context file name collisions, e.g. in the case
  1136. of "+lists.mh-mime".)
  1137.  
  1138. X.ti -.5i
  1139. $HOME/.news-contexts/[a-z]*
  1140. X.br
  1141. Context files for news groups.
  1142.  
  1143. X.ti -.5i
  1144. $HOME/.news-defaults
  1145. X.br
  1146. List of default news groups.
  1147.  
  1148. X.ti -.5i
  1149. $HOME/Mail
  1150. X.br
  1151. Default MH directory.
  1152.  
  1153. X.ti -.5i
  1154. $HOME/Mail/context
  1155. X.br
  1156. Default MH context file.
  1157.  
  1158. X.in -1i
  1159.  
  1160. X.SH AUTHOR
  1161.  
  1162. Jerry Sweet <jsweet@ics.uci.edu>
  1163.  
  1164. X.SH MISCELLANEOUS INFORMATION
  1165.  
  1166. This man page describes version 1.5 of stacknews.
  1167.  
  1168. X.SH BUGS
  1169.  
  1170. It's easy to lose your way if you use "folder\ \-push".
  1171.  
  1172. Stacknews doesn't address some of the problems posed by using MH to
  1173. handle news groups, as well some general problems posed by
  1174. read-only folders.  
  1175. For example, the problem of posting news versus
  1176. sending e-mail needs to be addressed at some level between the UA and
  1177. the MTA.  
  1178. Another problem is that of copying versus linking messages.
  1179. Some partial work-arounds have been devised by the author, but these
  1180. are not yet in releasable form.
  1181. Some tweaks to MH itself (e.g. in the "post" program) might be
  1182. desirable the better to accommodate news and read-only folders.
  1183.  
  1184. X.SH SEE ALSO
  1185. X.IR csh (1),
  1186. X.IR mh(1)
  1187. //go.sysin dd *
  1188. made=TRUE
  1189. if [ $made = TRUE ]; then
  1190.     /bin/chmod 444 stacknews.l
  1191.     /bin/echo -n '    '; /bin/ls -ld stacknews.l
  1192. fi
  1193.